/*
 *  Copyright (C) 2010 glauco
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.common;

/**
 * Interface basica para componentes que representação algum campo de uma
 * entidade.
 * 
 * @author Glauco
 */
public interface EntityField extends Basic{

    /**
     * Retorna a classe do qual o campo pertense.
     */
    public Class getEntityClass();

    /**
     * Retorna a Classe do Atributo da entidade.
     */
    public Class getFieldClass();

    /**
     * Retorna o nome do atributo da entidade.
     */
    public String getFieldName();

    /**
     * Retorna o alias usado para construção do painel.
     */
    public String getAlias();

    /**
     * Retorna o tipo de EntityField.
     */
    public EntityFieldType getEntityFieldType();

    /**
     * Abilita ou desabilita a representação visual, caso exista.
     * Alguns componentes não podem ser abilitados e este método deve retornar
     * false neste casos.
     *
     * @param value se é para abilitar o componente ou desabilitar.
     * @return False se não é possível abilitar o componente, True caso
     * contrário.
     */
    public boolean setEnabled(boolean value);
}
